home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-9.10-netbook-remix-PL.iso / casper / filesystem.squashfs / usr / lib / python2.6 / DocXMLRPCServer.pyc (.txt) < prev    next >
Encoding:
Python Compiled Bytecode  |  2009-11-11  |  9.7 KB  |  262 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.6)
  3.  
  4. '''Self documenting XML-RPC Server.
  5.  
  6. This module can be used to create XML-RPC servers that
  7. serve pydoc-style documentation in response to HTTP
  8. GET requests. This documentation is dynamically generated
  9. based on the functions and methods registered with the
  10. server.
  11.  
  12. This module is built upon the pydoc and SimpleXMLRPCServer
  13. modules.
  14. '''
  15. import pydoc
  16. import inspect
  17. import re
  18. import sys
  19. from SimpleXMLRPCServer import SimpleXMLRPCServer, SimpleXMLRPCRequestHandler, CGIXMLRPCRequestHandler, resolve_dotted_attribute
  20.  
  21. class ServerHTMLDoc(pydoc.HTMLDoc):
  22.     '''Class used to generate pydoc HTML document for a server'''
  23.     
  24.     def markup(self, text, escape = None, funcs = { }, classes = { }, methods = { }):
  25.         '''Mark up some plain text, given a context of symbols to look for.
  26.         Each context dictionary maps object names to anchor names.'''
  27.         if not escape:
  28.             pass
  29.         escape = self.escape
  30.         results = []
  31.         here = 0
  32.         pattern = re.compile('\\b((http|ftp)://\\S+[\\w/]|RFC[- ]?(\\d+)|PEP[- ]?(\\d+)|(self\\.)?((?:\\w|\\.)+))\\b')
  33.         while None:
  34.             match = pattern.search(text, here)
  35.             if not match:
  36.                 break
  37.             
  38.             (start, end) = match.span()
  39.             (all, scheme, rfc, pep, selfdot, name) = match.groups()
  40.             if scheme:
  41.                 url = escape(all).replace('"', '"')
  42.                 results.append('<a href="%s">%s</a>' % (url, url))
  43.             elif rfc:
  44.                 url = 'http://www.rfc-editor.org/rfc/rfc%d.txt' % int(rfc)
  45.                 results.append('<a href="%s">%s</a>' % (url, escape(all)))
  46.             elif pep:
  47.                 url = 'http://www.python.org/dev/peps/pep-%04d/' % int(pep)
  48.                 results.append('<a href="%s">%s</a>' % (url, escape(all)))
  49.             elif text[end:end + 1] == '(':
  50.                 results.append(self.namelink(name, methods, funcs, classes))
  51.             elif selfdot:
  52.                 results.append('self.<strong>%s</strong>' % name)
  53.             else:
  54.                 results.append(self.namelink(name, classes))
  55.             here = end
  56.             continue
  57.             results.append(escape(text[here:]))
  58.             return ''.join(results)
  59.  
  60.     
  61.     def docroutine(self, object, name, mod = None, funcs = { }, classes = { }, methods = { }, cl = None):
  62.         '''Produce HTML documentation for a function or method object.'''
  63.         if not cl or cl.__name__:
  64.             pass
  65.         anchor = '' + '-' + name
  66.         note = ''
  67.         title = '<a name="%s"><strong>%s</strong></a>' % (self.escape(anchor), self.escape(name))
  68.         if inspect.ismethod(object):
  69.             (args, varargs, varkw, defaults) = inspect.getargspec(object.im_func)
  70.             argspec = inspect.formatargspec(args[1:], varargs, varkw, defaults, formatvalue = self.formatvalue)
  71.         elif inspect.isfunction(object):
  72.             (args, varargs, varkw, defaults) = inspect.getargspec(object)
  73.             argspec = inspect.formatargspec(args, varargs, varkw, defaults, formatvalue = self.formatvalue)
  74.         else:
  75.             argspec = '(...)'
  76.         if isinstance(object, tuple):
  77.             if not object[0]:
  78.                 pass
  79.             argspec = argspec
  80.             if not object[1]:
  81.                 pass
  82.             docstring = ''
  83.         else:
  84.             docstring = pydoc.getdoc(object)
  85.         if note:
  86.             pass
  87.         decl = title + argspec + self.grey('<font face="helvetica, arial">%s</font>' % note)
  88.         doc = self.markup(docstring, self.preformat, funcs, classes, methods)
  89.         if doc:
  90.             pass
  91.         doc = '<dd><tt>%s</tt></dd>' % doc
  92.         return '<dl><dt>%s</dt>%s</dl>\n' % (decl, doc)
  93.  
  94.     
  95.     def docserver(self, server_name, package_documentation, methods):
  96.         '''Produce HTML documentation for an XML-RPC server.'''
  97.         fdict = { }
  98.         for key, value in methods.items():
  99.             fdict[key] = '#-' + key
  100.             fdict[value] = fdict[key]
  101.         
  102.         server_name = self.escape(server_name)
  103.         head = '<big><big><strong>%s</strong></big></big>' % server_name
  104.         result = self.heading(head, '#ffffff', '#7799ee')
  105.         doc = self.markup(package_documentation, self.preformat, fdict)
  106.         if doc:
  107.             pass
  108.         doc = '<tt>%s</tt>' % doc
  109.         result = result + '<p>%s</p>\n' % doc
  110.         contents = []
  111.         method_items = sorted(methods.items())
  112.         for key, value in method_items:
  113.             contents.append(self.docroutine(value, key, funcs = fdict))
  114.         
  115.         result = result + self.bigsection('Methods', '#ffffff', '#eeaa77', pydoc.join(contents))
  116.         return result
  117.  
  118.  
  119.  
  120. class XMLRPCDocGenerator:
  121.     '''Generates documentation for an XML-RPC server.
  122.  
  123.     This class is designed as mix-in and should not
  124.     be constructed directly.
  125.     '''
  126.     
  127.     def __init__(self):
  128.         self.server_name = 'XML-RPC Server Documentation'
  129.         self.server_documentation = 'This server exports the following methods through the XML-RPC protocol.'
  130.         self.server_title = 'XML-RPC Server Documentation'
  131.  
  132.     
  133.     def set_server_title(self, server_title):
  134.         '''Set the HTML title of the generated server documentation'''
  135.         self.server_title = server_title
  136.  
  137.     
  138.     def set_server_name(self, server_name):
  139.         '''Set the name of the generated HTML server documentation'''
  140.         self.server_name = server_name
  141.  
  142.     
  143.     def set_server_documentation(self, server_documentation):
  144.         '''Set the documentation string for the entire server.'''
  145.         self.server_documentation = server_documentation
  146.  
  147.     
  148.     def generate_html_documentation(self):
  149.         '''generate_html_documentation() => html documentation for the server
  150.  
  151.         Generates HTML documentation for the server using introspection for
  152.         installed functions and instances that do not implement the
  153.         _dispatch method. Alternatively, instances can choose to implement
  154.         the _get_method_argstring(method_name) method to provide the
  155.         argument string used in the documentation and the
  156.         _methodHelp(method_name) method to provide the help text used
  157.         in the documentation.'''
  158.         methods = { }
  159.         for method_name in self.system_listMethods():
  160.             if method_name in self.funcs:
  161.                 method = self.funcs[method_name]
  162.             elif self.instance is not None:
  163.                 method_info = [
  164.                     None,
  165.                     None]
  166.                 if hasattr(self.instance, '_get_method_argstring'):
  167.                     method_info[0] = self.instance._get_method_argstring(method_name)
  168.                 
  169.                 if hasattr(self.instance, '_methodHelp'):
  170.                     method_info[1] = self.instance._methodHelp(method_name)
  171.                 
  172.                 method_info = tuple(method_info)
  173.                 if method_info != (None, None):
  174.                     method = method_info
  175.                 elif not hasattr(self.instance, '_dispatch'):
  176.                     
  177.                     try:
  178.                         method = resolve_dotted_attribute(self.instance, method_name)
  179.                     except AttributeError:
  180.                         method = method_info
  181.                     except:
  182.                         None<EXCEPTION MATCH>AttributeError
  183.                     
  184.  
  185.                 None<EXCEPTION MATCH>AttributeError
  186.                 method = method_info
  187.             elif not 0:
  188.                 raise AssertionError, 'Could not find method in self.functions and no instance installed'
  189.             methods[method_name] = method
  190.         
  191.         documenter = ServerHTMLDoc()
  192.         documentation = documenter.docserver(self.server_name, self.server_documentation, methods)
  193.         return documenter.page(self.server_title, documentation)
  194.  
  195.  
  196.  
  197. class DocXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
  198.     '''XML-RPC and documentation request handler class.
  199.  
  200.     Handles all HTTP POST requests and attempts to decode them as
  201.     XML-RPC requests.
  202.  
  203.     Handles all HTTP GET requests and interprets them as requests
  204.     for documentation.
  205.     '''
  206.     
  207.     def do_GET(self):
  208.         '''Handles the HTTP GET request.
  209.  
  210.         Interpret all HTTP GET requests as requests for server
  211.         documentation.
  212.         '''
  213.         if not self.is_rpc_path_valid():
  214.             self.report_404()
  215.             return None
  216.         response = self.server.generate_html_documentation()
  217.         self.send_response(200)
  218.         self.send_header('Content-type', 'text/html')
  219.         self.send_header('Content-length', str(len(response)))
  220.         self.end_headers()
  221.         self.wfile.write(response)
  222.         self.wfile.flush()
  223.         self.connection.shutdown(1)
  224.  
  225.  
  226.  
  227. class DocXMLRPCServer(SimpleXMLRPCServer, XMLRPCDocGenerator):
  228.     '''XML-RPC and HTML documentation server.
  229.  
  230.     Adds the ability to serve server documentation to the capabilities
  231.     of SimpleXMLRPCServer.
  232.     '''
  233.     
  234.     def __init__(self, addr, requestHandler = DocXMLRPCRequestHandler, logRequests = 1, allow_none = False, encoding = None, bind_and_activate = True):
  235.         SimpleXMLRPCServer.__init__(self, addr, requestHandler, logRequests, allow_none, encoding, bind_and_activate)
  236.         XMLRPCDocGenerator.__init__(self)
  237.  
  238.  
  239.  
  240. class DocCGIXMLRPCRequestHandler(CGIXMLRPCRequestHandler, XMLRPCDocGenerator):
  241.     '''Handler for XML-RPC data and documentation requests passed through
  242.     CGI'''
  243.     
  244.     def handle_get(self):
  245.         '''Handles the HTTP GET request.
  246.  
  247.         Interpret all HTTP GET requests as requests for server
  248.         documentation.
  249.         '''
  250.         response = self.generate_html_documentation()
  251.         print 'Content-Type: text/html'
  252.         print 'Content-Length: %d' % len(response)
  253.         print 
  254.         sys.stdout.write(response)
  255.  
  256.     
  257.     def __init__(self):
  258.         CGIXMLRPCRequestHandler.__init__(self)
  259.         XMLRPCDocGenerator.__init__(self)
  260.  
  261.  
  262.